Node / dev / reticulum / files / docs / source / reference.rst

Displaying Raw • Download

Tb4b4b4.. Tff7b72_api-main:

Tc9d1d9*************

Tc9d1d9API Reference

Tc9d1d9*************

This reference guide lists and explains all classes exposed by the RNS API.

Tc9d1d9Classes

Tc9d1d9=========================

Communication over a Reticulum network is achieved using a set of classes exposed by RNS.

Tb4b4b4.. Tff7b72_api-reticulum:

Tc9d1d9Reticulum

Tc9d1d9---------

Tb4b4b4.. Tff7b72autoclassTb4b4b4:: RNS.Reticulum

T56d364:members:

Tb4b4b4.. Tff7b72_api-identity:

Tc9d1d9Identity

Tc9d1d9--------

Tb4b4b4.. Tff7b72autoclassTb4b4b4:: RNS.Identity

T56d364:members:

Tb4b4b4.. Tff7b72_api-destination:

Tc9d1d9Destination

Tc9d1d9-----------

Tb4b4b4.. Tff7b72autoclassTb4b4b4:: RNS.Destination

T56d364:members:

Tb4b4b4.. Tff7b72_api-packet:

Tc9d1d9Packet

Tc9d1d9------

Tb4b4b4.. Tff7b72autoclassTb4b4b4:: RNS.Packet(destination, data, create_receipt = True)

T56d364:members:

Tb4b4b4.. Tff7b72_api-packetreceipt:

Tc9d1d9Packet Receipt

Tc9d1d9--------------

Tb4b4b4.. Tff7b72autoclassTb4b4b4:: RNS.PacketReceipt()

T56d364:members:

Tb4b4b4.. Tff7b72_api-link:

Tc9d1d9Link

Tc9d1d9----

Tb4b4b4.. Tff7b72autoclassTb4b4b4:: RNS.Link(destination, established_callback=None, closed_callback = None)

T56d364:members:

Tb4b4b4.. Tff7b72_api-requestreceipt:

Tc9d1d9Request Receipt

Tc9d1d9---------------

Tb4b4b4.. Tff7b72autoclassTb4b4b4:: RNS.RequestReceipt()

T56d364:members:

Tb4b4b4.. Tff7b72_api-resource:

Tc9d1d9Resource

Tc9d1d9--------

Tb4b4b4.. Tff7b72autoclassTb4b4b4:: RNS.Resource(data, link, advertise=True, auto_compress=True, callback=None, progress_callback=None, timeout=None)

T56d364:members:

Tb4b4b4.. Tff7b72_api-transport:

Tc9d1d9Transport

Tc9d1d9---------

Tb4b4b4.. Tff7b72autoclassTb4b4b4:: RNS.Transport

T56d364:members: